home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / keyb / recall12.zip / RECALL.DOC < prev    next >
Text File  |  1994-03-08  |  10KB  |  252 lines
  1.  
  2.  
  3.                                 RECALL, v1.2
  4.                                 -------------
  5.                                 from TifaWARE
  6.  
  7.  
  8.  
  9.  
  10. What's New
  11. ----------
  12.  
  13.      Version 1.2 fixes a bug that would rear its nasty head if you 
  14. redirected stdin; eg, "DEBUG < script.dbg". Basically, I hadn't bothered
  15. to strip linefeeds from the commandline as DOS does. Just after I fixed
  16. this problem I came across Ralf Brown's proposal for an alternative
  17. multiplex interrupt. By implementing it I'm now able to test much more
  18. reliably whether RECALL is loaded. Finally, I've added support for IBM's
  19. Interrupt Sharing Protocol, which permits removal of TSRs in arbitrary
  20. order. [Of course, your other TSRs must support this protocol too for it
  21. to be of much use.]
  22.  
  23.      Version 1.1 was the first public release of RECALL.
  24.  
  25.  
  26.  
  27.  
  28. Introduction
  29. ------------
  30.  
  31.  
  32.      RECALL is a memory-resident commandline editor and history utility.
  33. If you've been using DOS' built-in yet primitive editing keys until now 
  34. you'll be pleasantly surprised. With RECALL you get improved commandline
  35. editing as well as a 1K buffer for keeping track of old commandlines.
  36.  
  37.      Once installed in memory -- it takes about 2.5k -- RECALL intercepts
  38. requests for buffered input and processes them itself. Typically DOS uses
  39. this type of input to read commands at the familiar "C>" prompt; DEBUG and
  40. LIST use it too. Most keystrokes are saved in a buffer while you edit the
  41. commandline and then passed along when you hit <ENTER>. A few special
  42. keys, however, let you edit what you've just typed or even recall commands
  43. entered earlier. These special keys - described below - are what make
  44. RECALL so useful.
  45.  
  46.  
  47.  
  48.  
  49. Usage
  50. -----
  51.  
  52.  
  53.      Running this program is simple. Once you've put RECALL.COM where DOS
  54. can find it, type "RECALL -?" to display a brief help message similar to
  55. the following:
  56.  
  57.      TifaWARE RECALL, v1.2a, 11/16/91 - commandline editor and history TSR.
  58.      Usage: recall [-options]
  59.      
  60.      Options:
  61.        -i = install in memory
  62.        -l = list commandlines in recall buffer
  63.        -r = remove from memory
  64.        -? = display this help message
  65.      
  66.      Only one option can be specified at a time.
  67.  
  68. [If you don't remember anything else, at least remember how to display
  69. this help message.]
  70.  
  71.      There are two points of interest about RECALL's syntax. First, you
  72. must explicitly install RECALL in memory with the '-i' option. The reason
  73. for this is that I consider it impolite for any program to modify a user's
  74. environment without her permission. Second, RECALL's options are mutually
  75. exclusive. (Who'd want to specify more than one anyway?)
  76.  
  77.      It's easiest to install RECALL from your AUTOEXEC.BAT. This way
  78. you'll have it available always. Note that RECALL does not care where in
  79. the TSR chain it lies, except perhaps if you want to uninstall it later.
  80. If you do not install RECALL at boot-time though, remember it's unwise to
  81. install any TSR while "shelled out" from some other program.
  82.  
  83.      With RECALL resident, chances are you won't even notice its presence.
  84. Not, that is, until you need it. You'll enter commandlines as you did
  85. before. Only now, RECALL's power is just a keystroke away. Here's a
  86. summary of its features:
  87.  
  88.  
  89.           Key                 Action
  90.           ---------------     -----------------------------------------
  91. Movement: <LEFT>              Move cursor 1 character to left
  92.           <RIGHT>             Move cursor 1 character to right
  93.           <PGUP>              Move cursor 1 "word" to left
  94.           <PGDN>              Move cursor 1 "word" to right
  95.           <HOME>              Move cursor to start of line
  96.           <END>               Move cursor to end of line
  97.  
  98. History:  <UP>                Display previous command in recall buffer
  99.           <DOWN>              Display next command in recall buffer
  100.  
  101. Deletion:
  102.           <CTRL><LEFT>        Delete 1 character to left of cursor
  103.           <BS>                "
  104.           <CTRL><RIGHT>       Delete 1 character at cursor
  105.           <DEL>               "
  106.           <CTRL><PGUP>        Delete to start of previous "word"
  107.           <CTRL><PGDN>        Delete to start of next "word"
  108.           <CTRL><HOME>        Delete to start of line
  109.           <CTRL><END>         Delete to end of line
  110.           <ESC>               Delete entire line
  111.  
  112. Toggle:   <INS>               Toggle insert/overwrite mode
  113.           ---------------     -----------------------------------------
  114.  
  115.  
  116. [A "word" is delineated by blanks or the start/end of a commandline.] As a
  117. rule then, <KEY> serves to move along a commandline while <CTRL><KEY>
  118. serves to delete the corresponding group of characters. 
  119.  
  120.      After you've worked for a while you may want to list commandlines
  121. entered earlier. In this case invoke RECALL with the '-l' option to
  122. display the current buffer contents. You can redirect this output to a
  123. file, printer, or even another program using DOS' redirection characters
  124. '>', '>>', and '|'. 
  125.  
  126.      Like any good memory-resident program, RECALL can be removed from
  127. memory. Just specify the '-r' option. RECALL will sense whether it's safe
  128. to unhook itself and abort if not. RECALL should only balk if some other
  129. TSR you have loaded doesn't follow IBM's Interrupt Sharing Protocol.
  130.  
  131.  
  132.  
  133.  
  134. If You Have Any Trouble
  135. -----------------------
  136.  
  137.  
  138.      RECALL will let you know of problems that arise. Here are the
  139. possible error messages and how you should deal with each:
  140.  
  141.      recall: illegal option -- x.
  142.           - Type "RECALL -?" for a list of valid options.
  143.  
  144.      recall: DOS v1 is not supported.
  145.           - Sorry, you'll have to upgrade.
  146.  
  147.      recall: unable to go resident.
  148.           - Either RECALL found a copy of itself already 
  149.             active in memory or you have over 255 TSRs
  150.             loaded. Remove something.
  151.  
  152.      recall: unable to remove from memory.
  153.           - Some other TSR was installed later that does
  154.             not share interrupts.
  155.  
  156.      recall: not yet installed.
  157.           - You must install RECALL before you can list
  158.             the commandlines in its buffer or try to
  159.             uninstall it.
  160.  
  161. These messages are written to the standard error device. In this way, they
  162. won't disappear down a pipe or into a file when redirecting RECALL's
  163. output.
  164.  
  165.      Additionally, RECALL uses a return code to convey information about
  166. the success or failure of its operation. Possible return values are:
  167.  
  168.      Code      Meaning
  169.      ----      -------
  170.      0         RECALL was successfully installed or removed
  171.      1         Help message was displayed
  172.      5         Incorrect DOS version
  173.      10        Installation failed
  174.      20        Removal failed
  175.      25        RECALL has not yet been installed
  176.  
  177. You can test for these codes using the ERRORLEVEL construct in a batch file.
  178.  
  179.  
  180.  
  181.  
  182. Requirements
  183. ------------
  184.  
  185.  
  186.      TifaWARE RECALL should run on any machine running DOS v2.x or better.
  187. Don't worry about PC-compatibility unless your system uses something other
  188. than extended codes to represent keys on the numeric keypad. It requires
  189. about 2.5K of memory. 
  190.  
  191.      I regularly work with RECALL in a variety of environments - including
  192. DESQview, PC-LAN, and PolyShell. [DV users take note: RECALL does not
  193. churn thru CPU cycles while waiting for keystrokes and works fine with
  194. LOADHI.] While it is impossible to test RECALL in every configuration, the
  195. techniques used here are standard and should not lead to problems with
  196. other well-behaved TSRs, shells, or operating environments.
  197.  
  198.  
  199.  
  200.  
  201. Who Owns It?
  202. ------------
  203.  
  204.  
  205.      I am releasing this program into the public domain. Since 1984 I have
  206. used public-domain software extensively, and I find it to be a terrific
  207. idea. Most programs are useful, and the source instructive. And they cost
  208. nothing! With this small contribution to the public domain I hope to pay
  209. back my gratitude to those other programmers who have made my computing so
  210. much easier.
  211.  
  212.      However, this program carries no obligation on my part to support
  213. users or provide future upgrades. I try to